# What is Vim-Markup?

Vim-markup is a collection of functionalities aimed at bringing richer text to
vim text files and generally making dealing with simple text more pleasurable.
It consists of a single text.vim file that works with the builtin vim filetype
plugin.

Currently, it is not wholly complete, but its usable. I add features to it as I
need, but feel free to request anything in particular.

# Installation

First, clone or download this repository.

```text
git clone 'https://notabug.org/paone/vim-markup.git'
```
Then copy over the text.vim.

```text
cp vim-markup/text.vim ~/.vim/ftplugin/
```

# Usage

Use asterisks (\*) for bold, slashes (/) for italics and underlines (\_)
to underline text. To input literal asterisks, slashes or underlines, escape them
(e.g \\*). Special characters are acessed using the backslash (\), for example,
\-> produces a →. To check which special characters are avaiable and how to
input them, merely check the code.

Lastly, there is a function to fill the current line (up to the size of
textwidth) with line characters (\hl) or dashes (\dl).
